Download OpenAPI specification:Download
This REST API provides the ability to query various data elements in the system.
Please click this link to enable Swagger to call the APIs. Without this step, all attempts to try out the APIs will result in a 401 Not Authorized error.
| size |
integer
<int32>
Default:
50
Optional, limit to apply to the individual queries for orphaned events and homeless events, max 1000. Since this limit applies to each category of "unassociated events" individually, using a size of 50 could result in at most 100 returned events (50 homeless events, 50 orphaned events). |
| from |
string
Optional, bookmark to get the next chunk of results to a previously executed query. This must be the newFrom value from a previous unassociated events query. |
| eventTransactionId |
string
Optional, only include unassociated events that match this eventTransactionId. |
| sortBy |
string
Enum:
"eventOccurrenceTime"
"equipmentNumber"
"carrierBookingNumber"
"billOfLadingNumber"
Optional, the field on which to order the results |
| sortOrder |
string
Default:
"ascending"
Enum:
"ascending"
"descending"
Optional, the sort order to apply to sortBy field. |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"total": 0,
-
"size": 0,
-
"orphanedEvents":
[
-
{
-
"action":
"string",
-
"billOfLadingNumber":
"string",
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted,
Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"cargoRemainingOnboardCountries":
[
-
"AD"
],
-
"carrierBookingNumber":
"string",
-
"certificateType":
"string",
-
"consigneeId":
"string",
-
"consigneeIdType":
"string",
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"dangerousGoodsType":
"string",
-
"data":
[
-
{
-
"type":
"Barge",
-
"value":
"string"
}
],
-
"destinationOrgName":
"string",
-
"doc":
{
-
"contentUrl":
"string",
-
"description":
"string",
-
"docId":
"string",
-
"docReferences":
[
-
{
-
"referenceName":
"billOfLadingNumber",
-
"referenceValue":
"BOL8331939"
}
],
-
"docType":
"string",
-
"docVersion":
0
},
-
"document":
{
-
"description":
"Document
description",
-
"platformDocumentVersion":
0,
-
-
"hash":
"67c53aa7ddf77389914e2e319abdd158c96a451e2436156bb78e62964aab0930",
-
"hashEncodingType":
"MD5",
-
"platformDocumentId":
"string"
},
-
"documentId":
"string",
-
"documentType":
"string",
-
"documentVersion":
0,
-
"documents":
[
-
{
-
"description":
"Document
description",
-
"platformDocumentVersion":
0,
-
-
"hash":
"67c53aa7ddf77389914e2e319abdd158c96a451e2436156bb78e62964aab0930",
-
"hashEncodingType":
"MD5",
-
"platformDocumentId":
"string"
}
],
-
"eBLProvider":
"string",
-
"entryPort":
{
-
"unLocode":
"NLRTM"
},
-
"equipmentNumber":
"string",
-
"equipmentType":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"exitPort":
{
-
"unLocode":
"NLRTM"
},
-
"firstPortOfEntryCountry":
"AD",
-
"fullStatus":
"Full",
-
"harmonizedCodes":
[
-
"string"
],
-
"location":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"netWeight":
"string",
-
"newSlotNumber":
"string",
-
"operatorCode":
"string",
-
"operatorName":
"string",
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"packingListNumber":
"string",
-
"partBill":
false,
-
"partBillOf":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
},
-
"reasonCode":
"string",
-
"reasonForSurvey":
"string",
-
"references":
[
-
{
-
"reference":
"myReference-1",
-
"type":
"proformaInvoiceNumber"
}
],
-
"sealNumber":
"string",
-
"sealType":
"Carrier",
-
"seals":
[
-
{
-
"sealNumber":
"SEAL736481273",
-
"sealType":
"Carrier"
}
],
-
"senderOrgName":
"string",
-
"shipperId":
"string",
-
"shipperIdType":
"string",
-
"splitFromConsignment":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
},
-
"terminal":
{
-
"unLocode":
"NLRTM+11+RULED:139:6+PLP:72:306"
},
-
"terminalDescription":
"Rotterdam, ZH,
NL",
-
"transitExportCountries":
[
-
"AD"
],
-
"transitImportCountries":
[
-
"AD"
],
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"transshipmentPortDescriptions":
[
-
"string"
],
-
"transshipmentPorts":
[
-
{
-
"unLocode":
"NLRTM"
}
],
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"verifiedGrossMass":
"string",
-
"voyageId":
"string",
-
"waypointId":
"string"
}
],
-
"homelessEvents":
[
-
{
-
"action":
"string",
-
"billOfLadingNumber":
"string",
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted,
Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"cargoRemainingOnboardCountries":
[
-
"AD"
],
-
"carrierBookingNumber":
"string",
-
"certificateType":
"string",
-
"consigneeId":
"string",
-
"consigneeIdType":
"string",
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"dangerousGoodsType":
"string",
-
"data":
[
-
{
-
"type":
"Barge",
-
"value":
"string"
}
],
-
"destinationOrgName":
"string",
-
"doc":
{
-
"contentUrl":
"string",
-
"description":
"string",
-
"docId":
"string",
-
"docReferences":
[
-
{
-
"referenceName":
"billOfLadingNumber",
-
"referenceValue":
"BOL8331939"
}
],
-
"docType":
"string",
-
"docVersion":
0
},
-
"document":
{
-
"description":
"Document
description",
-
"platformDocumentVersion":
0,
-
-
"hash":
"67c53aa7ddf77389914e2e319abdd158c96a451e2436156bb78e62964aab0930",
-
"hashEncodingType":
"MD5",
-
"platformDocumentId":
"string"
},
-
"documentId":
"string",
-
"documentType":
"string",
-
"documentVersion":
0,
-
"documents":
[
-
{
-
"description":
"Document
description",
-
"platformDocumentVersion":
0,
-
-
"hash":
"67c53aa7ddf77389914e2e319abdd158c96a451e2436156bb78e62964aab0930",
-
"hashEncodingType":
"MD5",
-
"platformDocumentId":
"string"
}
],
-
"eBLProvider":
"string",
-
"entryPort":
{
-
"unLocode":
"NLRTM"
},
-
"equipmentNumber":
"string",
-
"equipmentType":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"exitPort":
{
-
"unLocode":
"NLRTM"
},
-
"firstPortOfEntryCountry":
"AD",
-
"fullStatus":
"Full",
-
"harmonizedCodes":
[
-
"string"
],
-
"location":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"netWeight":
"string",
-
"newSlotNumber":
"string",
-
"operatorCode":
"string",
-
"operatorName":
"string",
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"packingListNumber":
"string",
-
"partBill":
false,
-
"partBillOf":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
},
-
"reasonCode":
"string",
-
"reasonForSurvey":
"string",
-
"references":
[
-
{
-
"reference":
"myReference-1",
-
"type":
"proformaInvoiceNumber"
}
],
-
"sealNumber":
"string",
-
"sealType":
"Carrier",
-
"seals":
[
-
{
-
"sealNumber":
"SEAL736481273",
-
"sealType":
"Carrier"
}
],
-
"senderOrgName":
"string",
-
"shipperId":
"string",
-
"shipperIdType":
"string",
-
"splitFromConsignment":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
},
-
"terminal":
{
-
"unLocode":
"NLRTM+11+RULED:139:6+PLP:72:306"
},
-
"terminalDescription":
"Rotterdam, ZH,
NL",
-
"transitExportCountries":
[
-
"AD"
],
-
"transitImportCountries":
[
-
"AD"
],
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"transshipmentPortDescriptions":
[
-
"string"
],
-
"transshipmentPorts":
[
-
{
-
"unLocode":
"NLRTM"
}
],
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"verifiedGrossMass":
"string",
-
"voyageId":
"string",
-
"waypointId":
"string"
}
],
-
"newFrom":
"string"
}
Queries for all consignments visible to the user, filtered using the criteria below.
We return up to a maximum of 1000 consignments in one query. Paging is used to retrieve consignments beyond this number. Provide the "newFrom" value from the response body as the "from" parameter to retrieve the next page of results. If "from" is given, all other parameters are ignored, except for "size".
For the fields listed below, wildcard matching is supported. A '*' can be used in place of one or more characters, and a '?' can replace a single character.
Commodity information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of the correct types, then the following fields will be removed from all consignment response objects, and you will not be allowed to search on these fields:
| size |
integer
<int32>
Default:
50
Optional, number of consignments to return, max 1000 |
| from |
string
Optional, bookmark to get the next chunk of results to a previously executed query. This must be the newFrom value from a previous consignments query. |
| createdBy |
Array of strings
Optional, only include results that were created by any of the given organizations |
| createdAfter |
integer
<int64>
Optional, only include results that were created on or after this date. The date must be in epoch format. |
| createdBefore |
integer
<int64>
Optional, only include results that were created on or before this date. The date must be in epoch format. |
| exportCountry |
string
Optional, only include results that match this export country |
| importCountry |
string
Optional, only include results that match this import country |
| entryPort |
string
Optional, only include results that match this entry port |
| exitPort |
string
Optional, only include results that match this exit port |
| consignmentId |
string
Optional, only include results that match this consignment ID |
| consignmentRef |
string
Optional, only include results that match this consignment reference |
| status |
string
Optional, only include results that match this consignment status |
| transportEquipmentId |
string
Optional, only include results with a container that matches this transport equipment ID |
| transportEquipmentRef |
string
Optional, only include results with a container that matches this transport equipment reference |
| equipmentNumber |
string
Optional, only include results with a transport equipment that matches this equipment number |
| billOfLadingNumber |
string
Optional, only include results that match this bill of lading number |
| harmonizedCode |
string
Optional, only include results that match this harmonized system code. Your org must have permission to see commodity information to search on this parameter |
| carrierBookingNumber |
string
Optional, only include results that match this carrier booking number |
| terminal |
string
Optional, only include results that match this terminal name |
| startPlannedVesselDeparture |
integer
<int64>
Optional, start date in Planned Vessel Departure date range. Only include results where a consignment leaves the Exit Port (Planned Vessel Departure) on this date or later. The date must be in epoch milliseconds format. The value used will be this epoch day at time 00:00:01 HH:MM:SS |
| endPlannedVesselDeparture |
integer
<int64>
Optional, end date in Planned Vessel Departure date range. Only include results where a consignment leaves the Exit Port (Planned Vessel Departure) on this date or earlier. The date must be in epoch milliseconds format. The value used will be this epoch day at time 23:59:59 HH:MM:SS |
| startPlannedVesselArrival |
integer
<int64>
Optional, start date in Planned Vessel Arrival date range. Only include results where a consignment arrives at the Entry Port (Planned Vessel Arrival) on this date or later. The date must be in epoch milliseconds format. The value used will be this epoch day at time 00:00:01 HH:MM:SS |
| endPlannedVesselArrival |
integer
<int64>
Optional, end date in Planned Vessel Arrival date range. Only include results where a consignment arrives at the Entry Port (Planned Vessel Arrival) on this date or earlier. The date must be in epoch milliseconds format. The value used will be this epoch day at time 23:59:59 HH:MM:SS |
| originLocation |
string
Optional, only include results that match the value of the origin location. Searches for matches in the originLocation in the booking data as well as the exit port |
| destinationLocation |
string
Optional, only include results that match the value of the destination location. Searches for matches in the destinationLocation in the bookingData as well as the entry port |
| startBookingDepartureDate |
integer
<int64>
Optional, start departure date in Booking . Only include results where a consignment leaves the origin on this date or later. The date must be in epoch milliseconds format. The value used will be this epoch day at time 00:00:01 HH:MM:SS |
| endBookingDepartureDate |
integer
<int64>
Optional, end departure date in Booking. Only include results when a consignment arrives at the destination on this date or earlier. The date must be in epoch milliseconds format. The value used will be this epoch day at time 23:59:59 HH:MM:SS |
| commodityHarmonizedCode |
string
Optional, only include results that match this commodity harmonized system code. Your org must have permission to see harmonized system codes to search on this parameter |
| commodityDescription |
string
Optional, only include results that match this commodity description. Your org must have permission to see commodity information to search on this parameter |
| vehicleName |
string
Optional, only include results that match this vehicleName in the bookingData |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"total": 0,
-
"size": 0,
-
"consignments":
[
-
{
-
"consignmentId":
"string",
-
"carrierBookingNumber":
"string",
-
"consignmentRefs":
[
-
"string"
],
-
"status":
"Active",
-
"cutOffs":
[
-
{
-
"cutOffDateTime8601":
"string",
-
"cutOffType":
"Cargo",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
}
}
],
-
"transportEquipmentIds":
[
-
"string"
],
-
"transportEquipmentRefs":
[
-
"string"
],
-
"exportCountries":
[
-
"string"
],
-
"importCountries":
[
-
"string"
],
-
"entryPorts":
[
-
"string"
],
-
"exitPorts":
[
-
"string"
],
-
"harmonizedCodes":
[
-
"string"
],
-
"billOfLadingNumbers":
[
-
"string"
],
-
"creationTime":
0,
-
"terminals":
[
-
"string"
],
-
"plannedVesselArrival":
1514782800000,
-
"plannedVesselDeparture":
1514782800000,
-
"eventCreationTime":
0,
-
"eventUpdateTime":
0,
-
"consignmentCreationTime":
0,
-
"consignmentUpdateTime":
0,
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted,
Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"parentConsignmentIds":
[
-
"string"
],
-
"subcontractIds":
[
-
"string"
],
-
"callerRoles":
[
-
"string"
],
-
"createdBy":
"string",
-
"splitFromConsignment":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
},
-
"combinedIntoConsignment":
{
-
"billOfLadingNumber":
"string",
-
"carrierBookingNumber":
"string",
-
"consignmentId":
"string"
},
-
"combinedConsignments":
[
-
{
-
"billOfLadingNumber":
"string",
-
"carrierBookingNumber":
"string",
-
"consignmentId":
"string"
}
],
-
"formerlyAssociatedTransportEquipment":
[
-
{
-
"transportEquipmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
}
],
-
"partBillOf":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
}
}
],
-
"newFrom":
"string"
}
Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:
Originator information:
In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.
|
consignmentId
required
|
string
Get the events of this consignment |
| eventFilter |
string
Default:
"all"
{all | latest} |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"events":
[
-
{
-
"action":
"string",
-
"billOfLadingNumber":
"string",
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted,
Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"cargoRemainingOnboardCountries":
[
-
"AD"
],
-
"carrierBookingNumber":
"string",
-
"certificateType":
"string",
-
"consigneeId":
"string",
-
"consigneeIdType":
"string",
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"dangerousGoodsType":
"string",
-
"data":
[
-
{
-
"type":
"Barge",
-
"value":
"string"
}
],
-
"destinationOrgName":
"string",
-
"doc":
{
-
"contentUrl":
"string",
-
"description":
"string",
-
"docId":
"string",
-
"docReferences":
[
-
{
-
"referenceName":
"billOfLadingNumber",
-
"referenceValue":
"BOL8331939"
}
],
-
"docType":
"string",
-
"docVersion":
0
},
-
"document":
{
-
"description":
"Document
description",
-
"platformDocumentVersion":
0,
-
-
"hash":
"67c53aa7ddf77389914e2e319abdd158c96a451e2436156bb78e62964aab0930",
-
"hashEncodingType":
"MD5",
-
"platformDocumentId":
"string"
},
-
"documentId":
"string",
-
"documentType":
"string",
-
"documentVersion":
0,
-
"documents":
[
-
{
-
"description":
"Document
description",
-
"platformDocumentVersion":
0,
-
-
"hash":
"67c53aa7ddf77389914e2e319abdd158c96a451e2436156bb78e62964aab0930",
-
"hashEncodingType":
"MD5",
-
"platformDocumentId":
"string"
}
],
-
"eBLProvider":
"string",
-
"entryPort":
{
-
"unLocode":
"NLRTM"
},
-
"equipmentNumber":
"string",
-
"equipmentType":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"exitPort":
{
-
"unLocode":
"NLRTM"
},
-
"firstPortOfEntryCountry":
"AD",
-
"fullStatus":
"Full",
-
"harmonizedCodes":
[
-
"string"
],
-
"location":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"netWeight":
"string",
-
"newSlotNumber":
"string",
-
"operatorCode":
"string",
-
"operatorName":
"string",
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"packingListNumber":
"string",
-
"partBill":
false,
-
"partBillOf":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
},
-
"reasonCode":
"string",
-
"reasonForSurvey":
"string",
-
"references":
[
-
{
-
"reference":
"myReference-1",
-
"type":
"proformaInvoiceNumber"
}
],
-
"sealNumber":
"string",
-
"sealType":
"Carrier",
-
"seals":
[
-
{
-
"sealNumber":
"SEAL736481273",
-
"sealType":
"Carrier"
}
],
-
"senderOrgName":
"string",
-
"shipperId":
"string",
-
"shipperIdType":
"string",
-
"splitFromConsignment":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
},
-
"terminal":
{
-
"unLocode":
"NLRTM+11+RULED:139:6+PLP:72:306"
},
-
"terminalDescription":
"Rotterdam, ZH,
NL",
-
"transitExportCountries":
[
-
"AD"
],
-
"transitImportCountries":
[
-
"AD"
],
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"transshipmentPortDescriptions":
[
-
"string"
],
-
"transshipmentPorts":
[
-
{
-
"unLocode":
"NLRTM"
}
],
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"verifiedGrossMass":
"string",
-
"voyageId":
"string",
-
"waypointId":
"string"
}
]
}
Provide the consignment ID for a consignment. Transport Plan Analysis: This endpoint will return all of the transport plans for the consignment, ordered from most recent to oldest. Each transport plan will include a list of planned events, ordered by the event occurrence time. Together these events indicate the series of locations that each transport equipment, that is associated with the given consignnment, will move on its journey.
Planned events provide the planned route of a transport equipment.
Note that the only events returned by this endpoint are the set of events known as “transport” planned events. This does NOT include consignment, transport equipment, generic, or document events. For a complete list of transport events, see the Transport Events category in the Event Publish Swagger documentation. To get all events for a consignment use the …/events/consignmentId/{consignmentId} endpoint.
Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:
Originator information:
In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.
|
consignmentId
required
|
string
Consignment ID |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"consignment":
{
-
"consignmentId":
"7ciusuhd-8r3y12r-dhf-84683-sdfhiy32",
-
"consignmentRefs":
[
-
"string"
],
-
"carrierBookingNumber":
"string",
-
"status":
"Active",
-
"plannedVesselDeparture":
1514782800000,
-
"plannedVesselArrival":
1514782800000,
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted, Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"callerRoles":
[
-
"string"
],
-
"transportPlans":
[
-
{
-
"version":
0,
-
"transportPlanIssuanceTime8601":
"2017-09-15T20:30:00.000Z",
-
"senderOrgName":
"ACME",
-
"transportSummaryEvents":
[
-
{
-
"sequence":
1,
-
"event":
{
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"equipmentNumber":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"fullStatus":
"Full",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"senderOrgName":
"string",
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string"
}
}
]
}
]
}
}
Queries for all consignments visible to the user, filtered using the criteria below.
We return up to a maximum of 1000 consignments in one query. Paging is used to retrieve consignments beyond this number. Provide the "newFrom" value from the response body as the "from" parameter to retrieve the next page of results. If "from" is given, all other parameters are ignored, except for "size".
For the fields listed below, wildcard matching is supported. A '*' can be used in place of one or more characters, and a '?' can replace a single character.
Commodity information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of the correct types, then the following fields will be removed from all consignment response objects, and you will not be allowed to search on these fields:
| size |
integer
<int32>
Default:
50
Optional, number of consignments to return, max 1000 |
| from |
string
Optional, bookmark to get the next chunk of results to a previously executed query. This must be the newFrom value from a previous consignments query. |
| createdBy |
Array of strings
Optional, only include results that were created by any of the given organizations |
| createdAfter |
integer
<int64>
Optional, only include results that were created on or after this date. The date must be in epoch format. |
| createdBefore |
integer
<int64>
Optional, only include results that were created on or before this date. The date must be in epoch format. |
| exportCountry |
string
Optional, only include results that match this export country |
| importCountry |
string
Optional, only include results that match this import country |
| entryPort |
string
Optional, only include results that match this entry port |
| exitPort |
string
Optional, only include results that match this exit port |
| consignmentId |
string
Optional, only include results that match this consignment ID |
| referenceType |
string
Optional, only include results that match this reference type for the consignment. |
| references |
Array of strings
Optional, only include results that match these references number/code for the consignment. |
| status |
string
Optional, only include results that match this consignment status |
| transportEquipmentId |
string
Optional, only include results with a container that matches this transport equipment ID |
| transportEquipmentReferenceType |
string
Optional, only include results that match this transport equipment reference type. |
| transportEquipmentReferences |
Array of strings
Optional, only include results that match these trasport equipment references number/code. |
| equipmentNumber |
string
Optional, only include results with a transport equipment that matches this equipment number |
| billOfLadingNumber |
string
Optional, only include results that match this bill of lading number |
| harmonizedCode |
string
Optional, only include results that match this harmonized system code. Your org must have permission to see commodity information to search on this parameter |
| carrierBookingNumber |
string
Optional, only include results that match this carrier booking number |
| terminal |
string
Optional, only include results that match this terminal name |
| startPlannedVesselDeparture |
integer
<int64>
Optional, start date in Planned Vessel Departure date range. Only include results where a consignment leaves the Exit Port (Planned Vessel Departure) on this date or later. The date must be in epoch milliseconds format. The value used will be this epoch day at time 00:00:01 HH:MM:SS |
| endPlannedVesselDeparture |
integer
<int64>
Optional, end date in Planned Vessel Departure date range. Only include results where a consignment leaves the Exit Port (Planned Vessel Departure) on this date or earlier. The date must be in epoch milliseconds format. The value used will be this epoch day at time 23:59:59 HH:MM:SS |
| startPlannedVesselArrival |
integer
<int64>
Optional, start date in Planned Vessel Arrival date range. Only include results where a consignment arrives at the Entry Port (Planned Vessel Arrival) on this date or later. The date must be in epoch milliseconds format. The value used will be this epoch day at time 00:00:01 HH:MM:SS |
| endPlannedVesselArrival |
integer
<int64>
Optional, end date in Planned Vessel Arrival date range. Only include results where a consignment arrives at the Entry Port (Planned Vessel Arrival) on this date or earlier. The date must be in epoch milliseconds format. The value used will be this epoch day at time 23:59:59 HH:MM:SS |
| originLocation |
string
Optional, only include results that match the value of the origin location. Searches for matches in the originLocation in the booking data as well as the exit port |
| destinationLocation |
string
Optional, only include results that match the value of the destination location. Searches for matches in the destinationLocation in the bookingData as well as the entry port |
| startBookingDepartureDate |
integer
<int64>
Optional, start departure date in Booking . Only include results where a consignment leaves the origin on this date or later. The date must be in epoch milliseconds format. The value used will be this epoch day at time 00:00:01 HH:MM:SS |
| endBookingDepartureDate |
integer
<int64>
Optional, end departure date in Booking. Only include results when a consignment arrives at the destination on this date or earlier. The date must be in epoch milliseconds format. The value used will be this epoch day at time 23:59:59 HH:MM:SS |
| commodityHarmonizedCode |
string
Optional, only include results that match this commodity harmonized system code. Your org must have permission to see commodity information to search on this parameter |
| commodityDescription |
string
Optional, only include results that match this commodity description. Your org must have permission to see commodity information to search on this parameter |
| vehicleName |
string
Optional, only include results that match this vehicleName in the bookingData |
| onWater |
boolean
Optional, only include results where the onWater field equals the given value. OnWater is true if all the equipment for this consignment have been loaded onto the vessel but none have been discharged |
| transshipment |
boolean
Optional, only include results where the transshipment field equals the given value. Transhipment is true if two different vehicle IDs are used in the vessel transport events sent to the consignment or its equipment, indicating its equipment will be transferred between vessels mid journey |
| startChangeInVesselArrivalFromFirstPlan |
integer
<int64>
Optional, only include results where the plannedVesselArrival time has changed from its earliest value by the given amount or more, in milliseconds. A negative value for changeInVesselArrivalFromFirstPlan indicates the consignment is arriving earlier than expected, a positive value indicates the consignment is arriving later |
| endChangeInVesselArrivalFromFirstPlan |
integer
<int64>
Optional, only include results where the plannedVesselArrival time has changed from its earliest value by the given amount or less, in milliseconds. A negative value for changeInVesselArrivalFromFirstPlan indicates the consignment is arriving earlier than expected, a positive value indicates the consignment is arriving later |
| startChangeInVesselArrivalFromFirstPlanDays |
integer
<int64>
Optional, only include results where the plannedVesselArrival time has changed from its earliest value by the given amount or more, in days. A negative value for changeInVesselArrivalFromFirstPlan indicates the consignment is arriving earlier than expected, a positive value indicates the consignment is arriving later |
| endChangeInVesselArrivalFromFirstPlanDays |
integer
<int64>
Optional, only include results where the plannedVesselArrival time has changed from its earliest value by the given amount or less, in days. A negative value for changeInVesselArrivalFromFirstPlan indicates the consignment is arriving earlier than expected, a positive value indicates the consignment is arriving later |
| startLatestPlanIssuanceTime |
integer
<int64>
Optional, only include results where the latest set of planned events sent to this consignment had a transportPlanIssuanceTime of this time or later. Time in milliseconds since epoch. A user may either use the latestPlanIssuedInLastNDays param or this param, not both |
| endLatestPlanIssuanceTime |
integer
<int64>
Optional, only include results where the latest set of planned events sent to this consignment had a transportPlanIssuanceTime of this time or earlier. Time in milliseconds since epoch. A user may either use the latestPlanIssuedInLastNDays param or this param, not both |
| latestPlanIssuedInLastNDays |
integer
<int64>
Optional, only include results where the transport plan for this consignment was changed between now and n days ago. The consignment must have received more than one complete transport plan for the plan to have "changed". A user may not supply both this field and any of startNumberPlansReceived, endNumberPlansReceived, startLatestPlanIssuanceTime, endLatestPlanIssuanceTime, or planChangedLastNDays |
| planChangedLastNDays |
integer
<int64>
Optional, only include results where the transport plan for this consignment was changed between now and n days ago. The consignment must have received more than one complete transport plan for the plan to have "changed". A user may not supply both this field and any of startNumberPlansReceived, endNumberPlansReceived, startLatestPlanIssuanceTime, endLatestPlanIssuanceTime, or latestPlanIssuedInLastNDays |
| startNumberPlansReceived |
integer
<int64>
Optional, only include consignments which have received at least this many complete transport plans (inclusive) |
| endNumberPlansReceived |
integer
<int64>
Optional, only include consignments which have received at most this many complete transport plans (inclusive) |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"total": 0,
-
"size": 0,
-
"consignments":
[
-
{
-
"consignmentId":
"string",
-
"carrierBookingNumber":
"string",
-
"status":
"Active",
-
"cutOffs":
[
-
{
-
"cutOffDateTime8601":
"string",
-
"cutOffType":
"Cargo",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
}
}
],
-
"transportEquipmentIds":
[
-
"string"
],
-
"transportEquipmentRefs":
[
-
"string"
],
-
"exportCountries":
[
-
"string"
],
-
"importCountries":
[
-
"string"
],
-
"entryPorts":
[
-
"string"
],
-
"exitPorts":
[
-
"string"
],
-
"harmonizedCodes":
[
-
"string"
],
-
"billOfLadingNumbers":
[
-
"string"
],
-
"creationTime":
0,
-
"terminals":
[
-
"string"
],
-
"plannedVesselArrival":
1514782800000,
-
"plannedVesselDeparture":
1514782800000,
-
"eventCreationTime":
0,
-
"eventUpdateTime":
0,
-
"consignmentCreationTime":
0,
-
"consignmentUpdateTime":
0,
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted,
Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"parentConsignmentIds":
[
-
"string"
],
-
"subcontractIds":
[
-
"string"
],
-
"callerRoles":
[
-
"string"
],
-
"createdBy":
"string",
-
"splitFromConsignment":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
},
-
"combinedIntoConsignment":
{
-
"billOfLadingNumber":
"string",
-
"carrierBookingNumber":
"string",
-
"consignmentId":
"string"
},
-
"combinedConsignments":
[
-
{
-
"billOfLadingNumber":
"string",
-
"carrierBookingNumber":
"string",
-
"consignmentId":
"string"
}
],
-
"formerlyAssociatedTransportEquipment":
[
-
{
-
"transportEquipmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
}
],
-
"references":
[
-
{
-
"code":
"string",
-
"description":
"string",
-
"reference":
"myReference-1",
-
"type":
"proformaInvoiceNumber"
}
],
-
"onWater":
false,
-
"transshipment":
false,
-
"changeInVesselArrivalFromFirstPlan":
0,
-
"latestPlanIssuanceTime":
0,
-
"numberPlansReceived":
0,
-
"partBillOf":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
}
}
],
-
"newFrom":
"string"
}
Queries for all shipments visible to the user, filtered using the criteria below.
We return up to a maximum of 1000 shipments in one query. Paging is used to retrieve shipments beyond this number. Provide the "newFrom" value from the response body as the "from" parameter to retrieve the next page of results. If "from" is given, all other parameters are ignored, except for "size".
Note: A leading wildcard will not be added to shipment queries.
| size |
integer
<int32>
Default:
50
Optional, number of shipments to return, max 1000. |
| from |
string
Optional, bookmark to get the next chunk of results to a previously executed query. This must be the newFrom value from a previous shipment query. |
| shipmentId |
string
Optional, only include results that match this shipment ID. |
| createdBy |
Array of strings
Optional, only include results that were created by the given party. |
| createdAfter |
integer
<int64>
Optional, only include results that were created on or after this date. The date must be in epoch format. |
| createdBefore |
integer
<int64>
Optional, only include results that were created on or before this date. The date must be in epoch format. |
| myRole |
string
Optional, only include results where the caller has one of the given roles. |
| referenceType |
string
Optional, only include results that match this reference type for the shipment. |
| references |
Array of strings
Optional, only include results that match these references number/code for the shipment. |
| seller |
string
Optional, only include results where the party reference matches the role. |
| buyer |
string
Optional, only include results where the party reference matches the role. |
| exporter |
string
Optional, only include results where the party reference matches the role. |
| importer |
string
Optional, only include results where the party reference matches the role. |
| origin3plAgent |
string
Optional, only include results where the party reference matches the role. |
| destination3plAgent |
string
Optional, only include results where the party reference matches the role. |
| exportCustomsBroker |
string
Optional, only include results where the party reference matches the role. |
| importCustomsBroker |
string
Optional, only include results where the party reference matches the role. |
| exportAuthority |
string
Optional, only include results where the party reference matches the role. |
| importAuthority |
string
Optional, only include results where the party reference matches the role. |
| buyersBank |
string
Optional, only include results where the party reference matches the role. |
| sellersBank |
string
Optional, only include results where the party reference matches the role. |
| insuranceProvider |
string
Optional, only include results where the party reference matches the role. |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"total": 0,
-
"size": 0,
-
"shipments":
[
-
{
-
"shipmentId":
"string",
-
"shipmentCreationTime":
0,
-
"shipmentUpdateTime":
0,
-
"references":
[
-
{
-
"code":
"string",
-
"description":
"string",
-
"reference":
"myReference-1",
-
"type":
"proformaInvoiceNumber"
}
],
-
"goodsDescription":
"string",
-
"associatedConsignmentIds":
[
-
"string"
],
-
"plannedCompletionDate8601":
"string",
-
"plannedDeliveryDate8601":
"string"
}
],
-
"newFrom":
"string"
}
|
shipmentId
required
|
string
Fetch the events for a specific shipment. |
| eventFilter |
string
Default:
"all"
{all | latest} |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"events":
[
-
{
-
"action":
"string",
-
"billOfLadingNumber":
"string",
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted,
Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"cargoRemainingOnboardCountries":
[
-
"AD"
],
-
"carrierBookingNumber":
"string",
-
"certificateType":
"string",
-
"consigneeId":
"string",
-
"consigneeIdType":
"string",
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"dangerousGoodsType":
"string",
-
"data":
[
-
{
-
"type":
"Barge",
-
"value":
"string"
}
],
-
"destinationOrgName":
"string",
-
"doc":
{
-
"contentUrl":
"string",
-
"description":
"string",
-
"docId":
"string",
-
"docReferences":
[
-
{
-
"referenceName":
"billOfLadingNumber",
-
"referenceValue":
"BOL8331939"
}
],
-
"docType":
"string",
-
"docVersion":
0
},
-
"document":
{
-
"description":
"Document
description",
-
"platformDocumentVersion":
0,
-
-
"hash":
"67c53aa7ddf77389914e2e319abdd158c96a451e2436156bb78e62964aab0930",
-
"hashEncodingType":
"MD5",
-
"platformDocumentId":
"string"
},
-
"documentId":
"string",
-
"documentType":
"string",
-
"documentVersion":
0,
-
"documents":
[
-
{
-
"description":
"Document
description",
-
"platformDocumentVersion":
0,
-
-
"hash":
"67c53aa7ddf77389914e2e319abdd158c96a451e2436156bb78e62964aab0930",
-
"hashEncodingType":
"MD5",
-
"platformDocumentId":
"string"
}
],
-
"eBLProvider":
"string",
-
"entryPort":
{
-
"unLocode":
"NLRTM"
},
-
"equipmentNumber":
"string",
-
"equipmentType":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"exitPort":
{
-
"unLocode":
"NLRTM"
},
-
"firstPortOfEntryCountry":
"AD",
-
"fullStatus":
"Full",
-
"harmonizedCodes":
[
-
"string"
],
-
"location":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"netWeight":
"string",
-
"newSlotNumber":
"string",
-
"operatorCode":
"string",
-
"operatorName":
"string",
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"packingListNumber":
"string",
-
"partBill":
false,
-
"partBillOf":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
},
-
"reasonCode":
"string",
-
"reasonForSurvey":
"string",
-
"references":
[
-
{
-
"reference":
"myReference-1",
-
"type":
"proformaInvoiceNumber"
}
],
-
"sealNumber":
"string",
-
"sealType":
"Carrier",
-
"seals":
[
-
{
-
"sealNumber":
"SEAL736481273",
-
"sealType":
"Carrier"
}
],
-
"senderOrgName":
"string",
-
"shipperId":
"string",
-
"shipperIdType":
"string",
-
"splitFromConsignment":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
},
-
"terminal":
{
-
"unLocode":
"NLRTM+11+RULED:139:6+PLP:72:306"
},
-
"terminalDescription":
"Rotterdam, ZH,
NL",
-
"transitExportCountries":
[
-
"AD"
],
-
"transitImportCountries":
[
-
"AD"
],
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"transshipmentPortDescriptions":
[
-
"string"
],
-
"transshipmentPorts":
[
-
{
-
"unLocode":
"NLRTM"
}
],
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"verifiedGrossMass":
"string",
-
"voyageId":
"string",
-
"waypointId":
"string"
}
]
}
Queries for unique IDs of Freight Trust Network objects matching the given search criteria.
Search for consignments by providing the 'consignment' search criteria. Matching consignment IDs are returned.
Search for transport equipments by providing the 'transportEquipment' search criteria. Matching transport equipment IDs are returned.
Search for shipments by providing the 'shipment' search criteria. Matching shipment IDs are returned.
See Model to the right for the full description of the identifiers. Note that only one identifier can be specified (consignment, transportEquipment or shipment) and within that identifier, at least one field must be specified but not all are required.
|
object
(ConsignmentIdentifer)
|
|
|
object
(TransportEquipmentIdentifier)
|
|
|
object
(ShipmentIdentifer)
|
{
-
"consignment":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"BOL8331939",
-
"references":
[
-
{
-
"reference":
"myReference-1",
-
"type":
"proformaInvoiceNumber"
}
]
},
-
"transportEquipment":
{
-
"equipmentNumber":
"ACME1122334",
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"BOL8331939",
-
"references":
[
-
{
-
"reference":
"myReference-1",
-
"type":
"proformaInvoiceNumber"
}
]
},
-
"shipment":
{
-
"references":
[
-
{
-
"reference":
"myReference-1",
-
"type":
"proformaInvoiceNumber"
}
]
}
}
{
-
"tradeObjectIds":
[
-
{
-
"consignmentId":
"string",
-
"transportEquipmentId":
"string",
-
"shipmentId":
"string",
-
"relatedTradeInstrumentIds":
[
-
"string"
],
-
"creationTime":
0
}
]
}
Provide the consignmentId of a Consignment. Returns the current progress of all transport equipment associated with that consignment.
Transport events are divided into three categories: planned, estimated and actual. Planned events provide the planned route of a transport equipment. Estimated events provide the estimated time things will occur to the transport equipment. Actual events indicate things that occurred to the transport equipment.
Current Progress Analysis: The current progress will include a list of current progress events, ordered by the sequence in which they occur. Together these events indicate the series of locations that each transport equipment will move, or has moved, on its journey and everything that happened to it along the way. Each current progress event is made up of a list of actual events, a list of estimated events and the associated planned event.
Note that the only events returned by this endpoint are the set of events known as “transport” events. This does NOT include consignment, transport equipment, generic, or document events. For a complete list of transport events, see the Transport Events category in the Event Publish Swagger documentation. To get all events for a consignment or transport equipment, use the …/events/... endpoint.
Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:
Originator information:
In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.
|
consignmentId
required
|
string
Consignment ID |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"consignment":
{
-
"consignmentId":
"7ciusuhd-8r3y12r-dhf-84683-sdfhiy32",
-
"consignmentRefs":
[
-
"string"
],
-
"carrierBookingNumber":
"string",
-
"billOfLadingNumber":
"string",
-
"cutOffs":
[
-
{
-
"cutOffDateTime8601":
"string",
-
"cutOffType":
"Cargo",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
}
}
],
-
"plannedVesselDeparture":
1514782800000,
-
"plannedVesselArrival":
1514782800000,
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted, Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"cargoTypes":
[
-
{
-
"code":
"090121",
-
"description":
"Coffee
roasted"
}
]
},
-
"transportEquipmentList":
[
-
{
-
"transportEquipmentSummary":
{
-
"transportEquipmentId":
"781as5-1790-4059-bhh1-2cc0fcd03532",
-
"transportEquipmentRefs":
[
-
"string"
],
-
"billsOfLading":
"BOL419328",
-
"transportEquipmentTypes":
[
-
{
-
"code":
"20H0",
-
"description":
"INSULATED
CONTAINER"
}
],
-
"equipmentNumber":
"10193652010736",
-
"dangerousCargo":
true,
-
"cargoTypes":
[
-
{
-
"code":
"090121",
-
"description":
"Coffee
roasted"
}
],
-
"verifiedGrossMass":
"413kg",
-
"portOfEntry":
"NLRTM",
-
"portOfEntryDescription":
"Rotterdam,
ZH, NL",
-
"portOfDischarge":
"USNWK",
-
"portOfDischargeDescription":
"Newark, DE,
US",
-
"plannedVesselDeparture":
1514782800000,
-
"plannedVesselArrival":
1514782800000,
-
"terminals":
[
-
"string"
],
-
"terminalDescriptions":
[
-
"string"
],
-
"cutOffs":
[
-
{
-
"cutOffDateTime8601":
"string",
-
"cutOffType":
"Cargo",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
}
}
],
-
"callerRoles":
[
-
"string"
]
},
-
"transportPlanIssuanceTime8601":
"2017-09-15T20:30:00.000Z",
-
"senderOrgName":
"ACME",
-
"sequenceOfLastActual":
"ACME",
-
"currentProgressEvents":
[
-
{
-
"sequence":
1,
-
"locationKey":
"USNWK",
-
"actuals":
[
-
{
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"equipmentNumber":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"fullStatus":
"Full",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"senderOrgName":
"string",
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string"
}
],
-
"estimates":
[
-
{
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"equipmentNumber":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"fullStatus":
"Full",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"senderOrgName":
"string",
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string"
}
],
-
"planned":
{
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"equipmentNumber":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"fullStatus":
"Full",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"senderOrgName":
"string",
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string"
}
}
]
}
]
}
Provide the consignmentId for a consignment. Returns the current progress for all of the transport equipment split from the consignment that are not yet associated with another consignment. Current Progress Analysis: The current progress will include a list of current progress events, ordered by the sequence in which they occur. Together these events indicate the series of locations that each transport equipment will move, or has moved, on its journey and everything that happened to it along the way. Each current progress event is made up of a list of actual events, a list of estimated events and the associated planned event.
Note that the only events returned by this endpoint are the set of events known as “transport” events. This does NOT include consignment, transport equipment, generic, or document events. For a complete list of transport events, see the Transport Events category in the Event Publish Swagger documentation. To get all events for a consignment or transport equipment, use the …/events/... endpoint.
Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:
Originator information:
In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.
|
consignmentId
required
|
string
Consignment ID |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"consignment":
{
-
"consignmentId":
"7ciusuhd-8r3y12r-dhf-84683-sdfhiy32",
-
"consignmentRefs":
[
-
"string"
],
-
"carrierBookingNumber":
"string",
-
"billOfLadingNumber":
"string",
-
"cutOffs":
[
-
{
-
"cutOffDateTime8601":
"string",
-
"cutOffType":
"Cargo",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
}
}
],
-
"plannedVesselDeparture":
1514782800000,
-
"plannedVesselArrival":
1514782800000,
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted, Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"cargoTypes":
[
-
{
-
"code":
"090121",
-
"description":
"Coffee
roasted"
}
]
},
-
"transportEquipmentList":
[
-
{
-
"transportEquipmentSummary":
{
-
"transportEquipmentId":
"781as5-1790-4059-bhh1-2cc0fcd03532",
-
"transportEquipmentRefs":
[
-
"string"
],
-
"billsOfLading":
"BOL419328",
-
"transportEquipmentTypes":
[
-
{
-
"code":
"20H0",
-
"description":
"INSULATED
CONTAINER"
}
],
-
"equipmentNumber":
"10193652010736",
-
"dangerousCargo":
true,
-
"cargoTypes":
[
-
{
-
"code":
"090121",
-
"description":
"Coffee
roasted"
}
],
-
"verifiedGrossMass":
"413kg",
-
"portOfEntry":
"NLRTM",
-
"portOfEntryDescription":
"Rotterdam,
ZH, NL",
-
"portOfDischarge":
"USNWK",
-
"portOfDischargeDescription":
"Newark, DE,
US",
-
"plannedVesselDeparture":
1514782800000,
-
"plannedVesselArrival":
1514782800000,
-
"terminals":
[
-
"string"
],
-
"terminalDescriptions":
[
-
"string"
],
-
"cutOffs":
[
-
{
-
"cutOffDateTime8601":
"string",
-
"cutOffType":
"Cargo",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
}
}
],
-
"callerRoles":
[
-
"string"
]
},
-
"transportPlanIssuanceTime8601":
"2017-09-15T20:30:00.000Z",
-
"senderOrgName":
"ACME",
-
"sequenceOfLastActual":
"ACME",
-
"currentProgressEvents":
[
-
{
-
"sequence":
1,
-
"locationKey":
"USNWK",
-
"actuals":
[
-
{
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"equipmentNumber":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"fullStatus":
"Full",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"senderOrgName":
"string",
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string"
}
],
-
"estimates":
[
-
{
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"equipmentNumber":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"fullStatus":
"Full",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"senderOrgName":
"string",
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string"
}
],
-
"planned":
{
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"equipmentNumber":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"fullStatus":
"Full",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"senderOrgName":
"string",
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string"
}
}
]
}
]
}
Provide the transport equipment ID of a transport equipment. Returns the current progress of the transport equipment with that ID. Transport events are divided into three categories: planned, estimated and actual. Planned events provide the planned route of a transport equipment. Estimated events provide the estimated time things will occur to the transport equipment. Actual events indicate things that occurred to the transport equipment.
Current Progress Analysis: The current progress will include a list of current progress events, ordered by the sequence in which they occur. Together these events indicate the series of locations that each transport equipment will move, or has moved, on its journey and everything that happened to it along the way. Each current progress event is made up of a list of actual events, a list of estimated events and the associated planned event.
Note that the only events returned by this endpoint are the set of events known as “transport” events. This does NOT include consignment, transport equipment, generic, or document events. For a complete list of transport events, see the Transport Events category in the Event Publish Swagger documentation. To get all events for a consignment or transport equipment, use the …/events/... endpoint.
Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:
Originator information:
In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.
|
transportEquipmentId
required
|
string
Transport Equipment ID |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"consignment":
{
-
"consignmentId":
"7ciusuhd-8r3y12r-dhf-84683-sdfhiy32",
-
"consignmentRefs":
[
-
"string"
],
-
"carrierBookingNumber":
"string",
-
"billOfLadingNumber":
"string",
-
"cutOffs":
[
-
{
-
"cutOffDateTime8601":
"string",
-
"cutOffType":
"Cargo",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
}
}
],
-
"plannedVesselDeparture":
1514782800000,
-
"plannedVesselArrival":
1514782800000,
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted, Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"cargoTypes":
[
-
{
-
"code":
"090121",
-
"description":
"Coffee
roasted"
}
]
},
-
"transportEquipmentList":
[
-
{
-
"transportEquipmentSummary":
{
-
"transportEquipmentId":
"781as5-1790-4059-bhh1-2cc0fcd03532",
-
"transportEquipmentRefs":
[
-
"string"
],
-
"billsOfLading":
"BOL419328",
-
"transportEquipmentTypes":
[
-
{
-
"code":
"20H0",
-
"description":
"INSULATED
CONTAINER"
}
],
-
"equipmentNumber":
"10193652010736",
-
"dangerousCargo":
true,
-
"cargoTypes":
[
-
{
-
"code":
"090121",
-
"description":
"Coffee
roasted"
}
],
-
"verifiedGrossMass":
"413kg",
-
"portOfEntry":
"NLRTM",
-
"portOfEntryDescription":
"Rotterdam,
ZH, NL",
-
"portOfDischarge":
"USNWK",
-
"portOfDischargeDescription":
"Newark, DE,
US",
-
"plannedVesselDeparture":
1514782800000,
-
"plannedVesselArrival":
1514782800000,
-
"terminals":
[
-
"string"
],
-
"terminalDescriptions":
[
-
"string"
],
-
"cutOffs":
[
-
{
-
"cutOffDateTime8601":
"string",
-
"cutOffType":
"Cargo",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
}
}
],
-
"callerRoles":
[
-
"string"
]
},
-
"transportPlanIssuanceTime8601":
"2017-09-15T20:30:00.000Z",
-
"senderOrgName":
"ACME",
-
"sequenceOfLastActual":
"ACME",
-
"currentProgressEvents":
[
-
{
-
"sequence":
1,
-
"locationKey":
"USNWK",
-
"actuals":
[
-
{
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"equipmentNumber":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"fullStatus":
"Full",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"senderOrgName":
"string",
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string"
}
],
-
"estimates":
[
-
{
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"equipmentNumber":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"fullStatus":
"Full",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"senderOrgName":
"string",
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string"
}
],
-
"planned":
{
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"equipmentNumber":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"fullStatus":
"Full",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"senderOrgName":
"string",
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string"
}
}
]
}
]
}
Query for events belonging to all Transport Equipments associated with the Consignment with the given ID. The event filter parameter can be used to control how much processing is done to the resulting list.
If the eventFilter is not specified, the default is "all". You may optionally specify a transportEquipmentId to return only results for the transport equipment with that ID.
The list of events are sorted on occurrence time if present, otherwise the submission time.
Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:
Originator information:
In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.
|
consignmentId
required
|
string
Consignment ID |
| eventFilter |
string
{all | latest} |
| transportEquipmentIdFilter |
string
Transport Equipment ID |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"events":
[
-
{
-
"action":
"string",
-
"billOfLadingNumber":
"string",
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted,
Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"cargoRemainingOnboardCountries":
[
-
"AD"
],
-
"carrierBookingNumber":
"string",
-
"certificateType":
"string",
-
"consigneeId":
"string",
-
"consigneeIdType":
"string",
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"dangerousGoodsType":
"string",
-
"data":
[
-
{
-
"type":
"Barge",
-
"value":
"string"
}
],
-
"destinationOrgName":
"string",
-
"doc":
{
-
"contentUrl":
"string",
-
"description":
"string",
-
"docId":
"string",
-
"docReferences":
[
-
{
-
"referenceName":
"billOfLadingNumber",
-
"referenceValue":
"BOL8331939"
}
],
-
"docType":
"string",
-
"docVersion":
0
},
-
"document":
{
-
"description":
"Document
description",
-
"platformDocumentVersion":
0,
-
-
"hash":
"67c53aa7ddf77389914e2e319abdd158c96a451e2436156bb78e62964aab0930",
-
"hashEncodingType":
"MD5",
-
"platformDocumentId":
"string"
},
-
"documentId":
"string",
-
"documentType":
"string",
-
"documentVersion":
0,
-
"documents":
[
-
{
-
"description":
"Document
description",
-
"platformDocumentVersion":
0,
-
-
"hash":
"67c53aa7ddf77389914e2e319abdd158c96a451e2436156bb78e62964aab0930",
-
"hashEncodingType":
"MD5",
-
"platformDocumentId":
"string"
}
],
-
"eBLProvider":
"string",
-
"entryPort":
{
-
"unLocode":
"NLRTM"
},
-
"equipmentNumber":
"string",
-
"equipmentType":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"exitPort":
{
-
"unLocode":
"NLRTM"
},
-
"firstPortOfEntryCountry":
"AD",
-
"fullStatus":
"Full",
-
"harmonizedCodes":
[
-
"string"
],
-
"location":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"netWeight":
"string",
-
"newSlotNumber":
"string",
-
"operatorCode":
"string",
-
"operatorName":
"string",
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"packingListNumber":
"string",
-
"partBill":
false,
-
"partBillOf":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
},
-
"reasonCode":
"string",
-
"reasonForSurvey":
"string",
-
"references":
[
-
{
-
"reference":
"myReference-1",
-
"type":
"proformaInvoiceNumber"
}
],
-
"sealNumber":
"string",
-
"sealType":
"Carrier",
-
"seals":
[
-
{
-
"sealNumber":
"SEAL736481273",
-
"sealType":
"Carrier"
}
],
-
"senderOrgName":
"string",
-
"shipperId":
"string",
-
"shipperIdType":
"string",
-
"splitFromConsignment":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
},
-
"terminal":
{
-
"unLocode":
"NLRTM+11+RULED:139:6+PLP:72:306"
},
-
"terminalDescription":
"Rotterdam, ZH,
NL",
-
"transitExportCountries":
[
-
"AD"
],
-
"transitImportCountries":
[
-
"AD"
],
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"transshipmentPortDescriptions":
[
-
"string"
],
-
"transshipmentPorts":
[
-
{
-
"unLocode":
"NLRTM"
}
],
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"verifiedGrossMass":
"string",
-
"voyageId":
"string",
-
"waypointId":
"string"
}
]
}
Query for events for the Transport Equipment with the given ID. The event filter parameter can be used to control how much processing is done to the resulting list.
If the eventFilter is not specified, the default is "all". You may optionally specify a transportEquipmentId to return only results for the transport equipment with that ID.
The list of events are sorted on occurrence time if present, otherwise the submission time.
Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:
Originator information:
In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.
|
transportEquipmentId
required
|
string
Transport Equipment ID |
| eventFilter |
string
{all | latest} |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"events":
[
-
{
-
"action":
"string",
-
"billOfLadingNumber":
"string",
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted,
Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"cargoRemainingOnboardCountries":
[
-
"AD"
],
-
"carrierBookingNumber":
"string",
-
"certificateType":
"string",
-
"consigneeId":
"string",
-
"consigneeIdType":
"string",
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"dangerousGoodsType":
"string",
-
"data":
[
-
{
-
"type":
"Barge",
-
"value":
"string"
}
],
-
"destinationOrgName":
"string",
-
"doc":
{
-
"contentUrl":
"string",
-
"description":
"string",
-
"docId":
"string",
-
"docReferences":
[
-
{
-
"referenceName":
"billOfLadingNumber",
-
"referenceValue":
"BOL8331939"
}
],
-
"docType":
"string",
-
"docVersion":
0
},
-
"document":
{
-
"description":
"Document
description",
-
"platformDocumentVersion":
0,
-
-
"hash":
"67c53aa7ddf77389914e2e319abdd158c96a451e2436156bb78e62964aab0930",
-
"hashEncodingType":
"MD5",
-
"platformDocumentId":
"string"
},
-
"documentId":
"string",
-
"documentType":
"string",
-
"documentVersion":
0,
-
"documents":
[
-
{
-
"description":
"Document
description",
-
"platformDocumentVersion":
0,
-
-
"hash":
"67c53aa7ddf77389914e2e319abdd158c96a451e2436156bb78e62964aab0930",
-
"hashEncodingType":
"MD5",
-
"platformDocumentId":
"string"
}
],
-
"eBLProvider":
"string",
-
"entryPort":
{
-
"unLocode":
"NLRTM"
},
-
"equipmentNumber":
"string",
-
"equipmentType":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"exitPort":
{
-
"unLocode":
"NLRTM"
},
-
"firstPortOfEntryCountry":
"AD",
-
"fullStatus":
"Full",
-
"harmonizedCodes":
[
-
"string"
],
-
"location":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"netWeight":
"string",
-
"newSlotNumber":
"string",
-
"operatorCode":
"string",
-
"operatorName":
"string",
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"packingListNumber":
"string",
-
"partBill":
false,
-
"partBillOf":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
},
-
"reasonCode":
"string",
-
"reasonForSurvey":
"string",
-
"references":
[
-
{
-
"reference":
"myReference-1",
-
"type":
"proformaInvoiceNumber"
}
],
-
"sealNumber":
"string",
-
"sealType":
"Carrier",
-
"seals":
[
-
{
-
"sealNumber":
"SEAL736481273",
-
"sealType":
"Carrier"
}
],
-
"senderOrgName":
"string",
-
"shipperId":
"string",
-
"shipperIdType":
"string",
-
"splitFromConsignment":
{
-
"carrierBookingNumber":
"123456789",
-
"billOfLadingNumber":
"DMKLLE0020217",
-
"consignmentId":
"c93b1946-d8f7-11e7-9296-cec278b6b50a"
},
-
"terminal":
{
-
"unLocode":
"NLRTM+11+RULED:139:6+PLP:72:306"
},
-
"terminalDescription":
"Rotterdam, ZH,
NL",
-
"transitExportCountries":
[
-
"AD"
],
-
"transitImportCountries":
[
-
"AD"
],
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"transshipmentPortDescriptions":
[
-
"string"
],
-
"transshipmentPorts":
[
-
{
-
"unLocode":
"NLRTM"
}
],
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"verifiedGrossMass":
"string",
-
"voyageId":
"string",
-
"waypointId":
"string"
}
]
}
Provide the consignmentId of a Consignment. Returns the transport summary of all transport equipment associated with that consignment. Transport Plan Analysis: This endpoint will construct an up-to-date transport summary for each transport equipment returned by the query. This transport summary will include a list of transport plan events, ordered by the sequence in which they occur. Together these events indicate the series of locations that each transport equipment will move, or has moved, on its journey and everything that happened to it along the way.
Events are divided into three categories: planned, estimated and actual. Planned events provide the planned route of a transport equipment. Estimated events provide the estimated time things will occur to the transport equipment. Actual events indicate things that occurred to the transport equipment.
The event filter parameter can be used to control the processing done in the transport plan analysis.
latest - The transportPlanIssuanceTime8601 will be used to determine the most recent transport plan. All Actual events will be returned, no filtering is done. For Estimated events, the location, the eventSubmissionTime, the originatorId, and the fullStatus fields will be used to determine the most recent version of the event. Estimated events will be replaced by the corresponding Actual events. The resulting list will contain the Planned event (if there is one) followed by the Actual or Estimated (if not Actual).
all - All the transport plans sent to this trade object will be returned, from most recent to oldest. Each transport plan will have a version, the transport plan issuance date, and the name of the organization that sent the plan, along with the list of Planned events.
Note that the only events returned by this endpoint are the set of events known as “transport”events. This does NOT include consignment, transport equipment, generic, or document events. For a complete list of transport events, see the Transport Events category in the Event Publish Swagger documentation. To get all events for a consignment or transport equipment, use the …/events/... endpoint.
Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:
Originator information:
In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.
|
consignmentId
required
|
string
Consignment ID |
| eventFilter |
string
{all | latest} |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"consignment":
{
-
"consignmentId":
"7ciusuhd-8r3y12r-dhf-84683-sdfhiy32",
-
"consignmentRefs":
[
-
"string"
],
-
"carrierBookingNumber":
"string",
-
"billOfLadingNumber":
"string",
-
"cutOffs":
[
-
{
-
"cutOffDateTime8601":
"string",
-
"cutOffType":
"Cargo",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
}
}
],
-
"plannedVesselDeparture":
1514782800000,
-
"plannedVesselArrival":
1514782800000,
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted, Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"cargoTypes":
[
-
{
-
"code":
"090121",
-
"description":
"Coffee
roasted"
}
]
},
-
"transportEquipmentList":
[
-
{
-
"transportEquipmentId":
"781as5-1790-4059-bhh1-2cc0fcd03532",
-
"transportEquipmentRefs":
[
-
"string"
],
-
"billsOfLading":
"BOL419328",
-
"transportEquipmentTypes":
[
-
{
-
"code":
"20H0",
-
"description":
"INSULATED
CONTAINER"
}
],
-
"equipmentNumber":
"10193652010736",
-
"dangerousCargo":
true,
-
"cargoTypes":
[
-
{
-
"code":
"090121",
-
"description":
"Coffee
roasted"
}
],
-
"verifiedGrossMass":
"413kg",
-
"portOfEntry":
"NLRTM",
-
"portOfEntryDescription":
"Rotterdam, ZH,
NL",
-
"portOfDischarge":
"USNWK",
-
"portOfDischargeDescription":
"Newark, DE,
US",
-
"plannedVesselDeparture":
1514782800000,
-
"plannedVesselArrival":
1514782800000,
-
"terminals":
[
-
"string"
],
-
"terminalDescriptions":
[
-
"string"
],
-
"cutOffs":
[
-
{
-
"cutOffDateTime8601":
"string",
-
"cutOffType":
"Cargo",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
}
}
],
-
"callerRoles":
[
-
"string"
],
-
"transportPlans":
[
-
{
-
"version":
0,
-
"transportPlanIssuanceTime8601":
"2017-09-15T20:30:00.000Z",
-
"senderOrgName":
"ACME",
-
"transportSummaryEvents":
[
-
{
-
"sequence":
1,
-
"event":
{
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"equipmentNumber":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"fullStatus":
"Full",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"senderOrgName":
"string",
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string"
}
}
]
}
]
}
]
}
Provide the consignmentId for a consignment. Returns the transport summary for all of the transport equipment split from the consignment that are not yet associated with another consignment. Transport Plan Analysis: This endpoint will construct an up-to-date transport summary for each transport equipment returned by the query. This transport summary will include a list of transport plan events, ordered by the sequence in which they occur. Together these events indicate the series of locations that each transport equipment will move, or has moved, on its journey and everything that happened to it along the way.
Events are divided into three categories: planned, estimated and actual. Planned events provide the planned route of a transport equipment. Estimated events provide the estimated time things will occur to the transport equipment. Actual events indicate things that occurred to the transport equipment.
The event filter parameter can be used to control the processing done in the transport plan analysis.
latest - The transportPlanIssuanceTime8601 will be used to determine the most recent transport plan. All Actual events will be returned, no filtering is done. For Estimated events, the location, the eventSubmissionTime, the originatorId, and the fullStatus fields will be used to determine the most recent version of the event. Estimated events will be replaced by the corresponding Actual events. The resulting list will contain the Planned event (if there is one) followed by the Actual or Estimated (if not Actual).
all - All the transport plans sent to this transport equipment will be returned, from most recent to oldest. Each transport plan will have a version, the transport plan issuance date, and the name of the organization that sent the plan, along with the list of Planned events.
Note that the only events returned by this endpoint are the set of events known as “transport”events. This does NOT include consignment, transport equipment, generic, or document events.. For a complete list of transport events, see the Transport Events category in the Event Publish Swagger documentation. To get all events for a consignment or transport equipment, use the …/events/... endpoint.
Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:
Originator information:
In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.
|
consignmentId
required
|
string
Consignment ID |
| eventFilter |
string
{all | latest} |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"consignment":
{
-
"consignmentId":
"7ciusuhd-8r3y12r-dhf-84683-sdfhiy32",
-
"consignmentRefs":
[
-
"string"
],
-
"carrierBookingNumber":
"string",
-
"billOfLadingNumber":
"string",
-
"cutOffs":
[
-
{
-
"cutOffDateTime8601":
"string",
-
"cutOffType":
"Cargo",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
}
}
],
-
"plannedVesselDeparture":
1514782800000,
-
"plannedVesselArrival":
1514782800000,
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted, Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"cargoTypes":
[
-
{
-
"code":
"090121",
-
"description":
"Coffee
roasted"
}
]
},
-
"transportEquipmentList":
[
-
{
-
"transportEquipmentId":
"781as5-1790-4059-bhh1-2cc0fcd03532",
-
"transportEquipmentRefs":
[
-
"string"
],
-
"billsOfLading":
"BOL419328",
-
"transportEquipmentTypes":
[
-
{
-
"code":
"20H0",
-
"description":
"INSULATED
CONTAINER"
}
],
-
"equipmentNumber":
"10193652010736",
-
"dangerousCargo":
true,
-
"cargoTypes":
[
-
{
-
"code":
"090121",
-
"description":
"Coffee
roasted"
}
],
-
"verifiedGrossMass":
"413kg",
-
"portOfEntry":
"NLRTM",
-
"portOfEntryDescription":
"Rotterdam, ZH,
NL",
-
"portOfDischarge":
"USNWK",
-
"portOfDischargeDescription":
"Newark, DE,
US",
-
"plannedVesselDeparture":
1514782800000,
-
"plannedVesselArrival":
1514782800000,
-
"terminals":
[
-
"string"
],
-
"terminalDescriptions":
[
-
"string"
],
-
"cutOffs":
[
-
{
-
"cutOffDateTime8601":
"string",
-
"cutOffType":
"Cargo",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
}
}
],
-
"callerRoles":
[
-
"string"
],
-
"transportPlans":
[
-
{
-
"version":
0,
-
"transportPlanIssuanceTime8601":
"2017-09-15T20:30:00.000Z",
-
"senderOrgName":
"ACME",
-
"transportSummaryEvents":
[
-
{
-
"sequence":
1,
-
"event":
{
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"equipmentNumber":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"fullStatus":
"Full",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"senderOrgName":
"string",
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string"
}
}
]
}
]
}
]
}
Provide the transport equipment ID of a transport equipment. Returns the transport summary of the transport equipment with that ID. Transport Plan Analysis: This endpoint will construct an up-to-date transport summary for each transport equipment returned by the query. This transport summary will include a list of transport plan events, ordered by the sequence in which they occur. Together these events indicate the series of locations that each transport equipment will move, or has moved, on its journey and everything that happened to it along the way.
Events are divided into three categories: planned, estimated and actual. Planned events provide the planned route of a transport equipment. Estimated events provide the estimated time things will occur to the transport equipment. Actual events indicate things that occurred to the transport equipment.
The event filter parameter can be used to control the processing done in the transport plan analysis.
latest - The transportPlanIssuanceTime8601 will be used to determine the most recent transport plan. All Actual events will be returned, no filtering is done. For Estimated events, the location, the eventSubmissionTime, the originatorId, and the fullStatus fields will be used to determine the most recent version of the event. Estimated events will be replaced by the corresponding Actual events. The resulting list will contain the Planned event (if there is one) followed by the Actual or Estimated (if not Actual).
all - All the transport plans sent to this transport equipment will be returned, from most recent to oldest. Each transport plan will have a version, the transport plan issuance date, and the name of the organization that sent the plan, along with the list of Planned events.
Note that the only events returned by this endpoint are the set of events known as “transport”events. This does NOT include consignment, transport equipment, generic, or document events. For a complete list of transport events, see the Transport Events category in the Event Publish Swagger documentation. To get all events for a consignment or transport equipment, use the …/events/... endpoint.
Commodity and originator information visibility is restricted to orgs that were onboarded with certain types. If your org does not have one of these correct types, then you may not have visibility to the following fields in each event: Commodity information:
Originator information:
In addition, The originator information on a Party Add/Update/Remove event will be hidden if you are not the org who submitted the event or one of the parties being added. The originator information and 'destinationOrgName' field on a Document event whose 'action' field is 'issued', 'transferred', or 'surrendered' will be hidden if you are not the org who submitted the event or the org that the document is being transferred to.
|
transportEquipmentId
required
|
string
Transport Equipment ID |
| eventFilter |
string
{all | latest} |
| Accept-Language |
string
Default:
en
Accept-Language |
{
-
"consignment":
{
-
"consignmentId":
"7ciusuhd-8r3y12r-dhf-84683-sdfhiy32",
-
"consignmentRefs":
[
-
"string"
],
-
"carrierBookingNumber":
"string",
-
"billOfLadingNumber":
"string",
-
"cutOffs":
[
-
{
-
"cutOffDateTime8601":
"string",
-
"cutOffType":
"Cargo",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
}
}
],
-
"plannedVesselDeparture":
1514782800000,
-
"plannedVesselArrival":
1514782800000,
-
"bookingData":
{
-
"originLocation":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"destinationLocation":
{
-
"description":
"Rotterdam,
ZH, NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"contractCarriageCondition":
"SD_SD",
-
"departureTime8601":
"string",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string",
-
"transportEquipmentDetails":
[
-
{
-
"description":
"Livestock
carrier",
-
"equipmentType":
"22T3",
-
"equipmentQuantity":
0
}
],
-
"commodities":
[
-
{
-
"itemNumber":
1,
-
"commodityDescription":
"Coffee,
Roasted, Not
Decaffeinated",
-
"commodityHarmonizedCode":
"string",
-
"commodityQuantity":
0,
-
"commodityWeight":
"100
Kg"
}
]
},
-
"cargoTypes":
[
-
{
-
"code":
"090121",
-
"description":
"Coffee
roasted"
}
]
},
-
"transportEquipmentList":
[
-
{
-
"transportEquipmentId":
"781as5-1790-4059-bhh1-2cc0fcd03532",
-
"transportEquipmentRefs":
[
-
"string"
],
-
"billsOfLading":
"BOL419328",
-
"transportEquipmentTypes":
[
-
{
-
"code":
"20H0",
-
"description":
"INSULATED
CONTAINER"
}
],
-
"equipmentNumber":
"10193652010736",
-
"dangerousCargo":
true,
-
"cargoTypes":
[
-
{
-
"code":
"090121",
-
"description":
"Coffee
roasted"
}
],
-
"verifiedGrossMass":
"413kg",
-
"portOfEntry":
"NLRTM",
-
"portOfEntryDescription":
"Rotterdam, ZH,
NL",
-
"portOfDischarge":
"USNWK",
-
"portOfDischargeDescription":
"Newark, DE,
US",
-
"plannedVesselDeparture":
1514782800000,
-
"plannedVesselArrival":
1514782800000,
-
"terminals":
[
-
"string"
],
-
"terminalDescriptions":
[
-
"string"
],
-
"cutOffs":
[
-
{
-
"cutOffDateTime8601":
"string",
-
"cutOffType":
"Cargo",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
}
}
],
-
"callerRoles":
[
-
"string"
],
-
"transportPlans":
[
-
{
-
"version":
0,
-
"transportPlanIssuanceTime8601":
"2017-09-15T20:30:00.000Z",
-
"senderOrgName":
"ACME",
-
"transportSummaryEvents":
[
-
{
-
"sequence":
1,
-
"event":
{
-
"consignmentId":
"string",
-
"consignmentRef":
"string",
-
"correlationId":
"string",
-
"equipmentNumber":
"string",
-
"eventName":
"string",
-
"eventOccurrenceTime":
0,
-
"eventOccurrenceTime8601":
"string",
-
"eventPriority":
0,
-
"eventSubmissionGpsLocation":
"string",
-
"eventSubmissionTime":
0,
-
"eventTransactionId":
"string",
-
"eventType":
"string",
-
"fullStatus":
"Full",
-
"location":
{
-
"description":
"Rotterdam,
ZH,
NL",
-
"locationKey":
"string",
-
"type":
"UN/Locode",
-
"value":
"string",
-
"unlocode":
"USNWK",
-
"address":
{
-
"address1":
"1234
Tradelens
Ave",
-
"address2":
"Suite
1A",
-
"city":
"Raleigh",
-
"country":
"US",
-
"stateProvince":
"NC",
-
"zipPostal":
"27709-2195"
},
-
"smdgTerminal":
"USEWR-PNCT",
-
"geoCoord":
{
-
"latitude":
40.693351,
-
"longitude":
-74.147572
},
-
"splc":
"191821",
-
"gln":
"1234567890123"
},
-
"originatorId":
"string",
-
"originatorName":
"string",
-
"senderOrgName":
"string",
-
"transportEquipmentId":
"string",
-
"transportEquipmentRef":
"string",
-
"transportPlanIssuanceTime8601":
"string",
-
"transportationPhase":
"Import",
-
"vehicleId":
"string",
-
"vehicleName":
"string",
-
"voyageId":
"string"
}
}
]
}
]
}
]
}